package com.tutu.commons.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import springfox.documentation.service.Contact;

import java.util.ArrayList;

/**
 * @Program: b2c-cloud-store
 * @Description: swagger配置类
 * @Author: JK.TuTu
 * @Version: 1.0
 * @Create: 2022-12-20 09:02
 **/
@Configuration
@EnableSwagger2  //开启swagger 会扫描当前所在类以及子包所有的类型中的注解  若在启动类配置了 这里可以不配置
public class SwaggerConfig {

    /**
     * Docket是swagger全局配置对象
     * DocumentationType：指定文档类型为swagger2
     */
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())  //swagger基础信息
                .select()  // select()获取Docket中的选择器，返回ApiSelectorBuilder构造选择器，如扫描扫描包的注解
                /*
                 * RequestHandlerSelectors:请求处理器
                 *  basePackage:扫描指定包下的所有接口
                 *  any()：扫描所有的包
                 *  none()：不扫描
                 *  withClassAnnotation()：扫描指定类上的注解，参数是一个注解的反射对象
                 *  withMethodAnnotation()：扫描方法上的注解
                 */
                //.apis(RequestHandlerSelectors.basePackage("com.tutu.swagger.controller"))
                //.apis(RequestHandlerSelectors.withMethodAnnotation(GetMapping.class))
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                /*
                 * pathSelectors：路径选择器，过滤路径不扫描
                 * any()：选择所有路径
                 * none()：都不选择
                 * ant()：选择指定路径
                 * regex()：正则表达式
                 */
                .paths(PathSelectors.any())
                .build();
        //配置是否开启swagger 若为false  则浏览器不能返回
        //.enable(false);
    }

    // swagger文档信息
    public ApiInfo apiInfo() {
        // 作者信息
        Contact contact = new Contact(
                // 文档发布者的名称
                "JK.TuTu",
                // 文档发布者的网站地址
                "https://www.baidu.com",
                // 文档发布者的电子邮箱
                "2293587368@qq.com"
        );
        return new ApiInfo(
                // 标题
                "b2c-cloud-store❤️",
                // 文档描述
                "b2c-cloud-store项目1.0版本文档",
                // 版本号
                "1.0",
                // 服务组url地址
                "http://localhost:8080/#/",
                // 作者信息
                contact,
                // 开源组织
                "TuTU项目组",
                // 开源地址
                "https://gitee.com/jktutu/b2c-cloud-store.git",
                // 集合
                new ArrayList<>()
        );
    }
}
